home *** CD-ROM | disk | FTP | other *** search
/ Australian Personal Computer 2002 November / CD 1 / APC0211D1.ISO / workshop / prog / files / ActivePerl-5.6.1.633-MSWin32.msi / _d29be891decee07357345792599b3cda < prev    next >
Encoding:
Text File  |  2002-05-01  |  7.5 KB  |  243 lines
  1. package Net::HTTP;
  2.  
  3. # $Id: HTTP.pm,v 1.39 2001/12/03 22:04:54 gisle Exp $
  4.  
  5. use strict;
  6. use vars qw($VERSION @ISA);
  7.  
  8. $VERSION = "0.04";
  9. eval { require IO::Socket::INET } || require IO::Socket;
  10. require Net::HTTP::Methods;
  11.  
  12. @ISA=qw(IO::Socket::INET Net::HTTP::Methods);
  13.  
  14. sub configure {
  15.     my($self, $cnf) = @_;
  16.     $self->http_configure($cnf);
  17. }
  18.  
  19. sub http_connect {
  20.     my($self, $cnf) = @_;
  21.     $self->SUPER::configure($cnf);
  22. }
  23.  
  24. 1;
  25.  
  26. __END__
  27.  
  28. =head1 NAME
  29.  
  30. Net::HTTP - Low-level HTTP client connection
  31.  
  32. =head1 NOTE
  33.  
  34. This module is experimental.  Details of its interface is likely to
  35. change in the future.
  36.  
  37. =head1 SYNOPSIS
  38.  
  39.  use Net::HTTP;
  40.  my $s = Net::HTTP->new(Host => "www.perl.com) || die $@;
  41.  $s->write_request(GET => "/", 'User-Agent' => "Mozilla/5.0");
  42.  my($code, $mess, %h) = $s->read_response_headers;
  43.  
  44.  while (1) {
  45.     my $buf;
  46.     my $n = $s->read_entity_body($buf, 1024);
  47.     last unless $n;
  48.     print $buf;
  49.  }
  50.  
  51. =head1 DESCRIPTION
  52.  
  53. The C<Net::HTTP> class is a low-level HTTP client.  An instance of the
  54. C<Net::HTTP> class represents a connection to an HTTP server.  The
  55. HTTP protocol is described in RFC 2616.
  56.  
  57. C<Net::HTTP> is a sub-class of C<IO::Socket::INET>.  You can mix the
  58. methods described below with reading and writing from the socket
  59. directly.  This is not necessary a good idea, unless you know what you
  60. are doing.
  61.  
  62. The following methods are provided (in addition to those of
  63. C<IO::Socket::INET>):
  64.  
  65. =over
  66.  
  67. =item $s = Net::HTTP->new( %options )
  68.  
  69. The C<Net::HTTP> constructor takes the same options as
  70. C<IO::Socket::INET> as well as these:
  71.  
  72.   Host:            Initial host attribute value
  73.   KeepAlive:       Initial keep_alive attribute value
  74.   SendTE:          Initial send_te attribute_value
  75.   HTTPVersion:     Initial http_version attribute value
  76.   PeerHTTPVersion: Initial peer_http_version attribute value
  77.   MaxLineLength:   Initial max_line_length attribute value
  78.   MaxHeaderLines:  Initial max_header_lines attribute value
  79.  
  80. =item $s->host
  81.  
  82. Get/set the default value of the C<Host> header to send.  The $host
  83. should not be set to an empty string (or C<undef>).
  84.  
  85. =item $s->keep_alive
  86.  
  87. Get/set the I<keep-alive> value.  If this value is TRUE then the
  88. request will be sent with headers indicating that the server should try
  89. to keep the connection open so that multiple requests can be sent.
  90.  
  91. The actual headers set will depend on the value of the C<http_version>
  92. and C<peer_http_version> attributes.
  93.  
  94. =item $s->send_te
  95.  
  96. Get/set the a value indicating if the request will be sent with a "TE"
  97. header to indicate the transfer encodings that the server can chose to
  98. use.  If the C<Compress::Zlib> module is installed then this will
  99. annouce that this client accept both the I<deflate> and I<gzip>
  100. encodings.
  101.  
  102. =item $s->http_version
  103.  
  104. Get/set the HTTP version number that this client should announce.
  105. This value can only be set to "1.0" or "1.1".  The default is "1.1".
  106.  
  107. =item $s->peer_http_version
  108.  
  109. Get/set the protocol version number of our peer.  This value will
  110. initially be "1.0", but will be updated by a successful
  111. read_response_headers() method call.
  112.  
  113. =item $s->max_line_length
  114.  
  115. Get/set a limit on the length of response line and response header
  116. lines.  The default is 4096.  A value of 0 means no limit.
  117.  
  118. =item $s->max_header_length
  119.  
  120. Get/set a limit on the number of headers lines that a response can
  121. have.  The default is 128.  A value of 0 means no limit.
  122.  
  123. =item $s->format_request($method, $uri, %headers, [$content])
  124.  
  125. Format a request message and return it as a string.  If the headers do
  126. not include a C<Host> header, then a header is inserted with the value
  127. of the C<host> attribute.  Headers like C<Connection> and
  128. C<Keep-Alive> might also be added depending on the status of the
  129. C<keep_alive> attribute.
  130.  
  131. If $content is given (and it is non-empty), then a C<Content-Length>
  132. header is automatically added unless it was already present.
  133.  
  134. =item $s->write_request($method, $uri, %headers, [$content])
  135.  
  136. Format and send a request message.  Arguments are the same as for
  137. format_request().  Returns true if successful.
  138.  
  139. =item $s->write_chunk($data)
  140.  
  141. Will write a new chunk of request entity body data.  This method
  142. should only be used if the C<Transfer-Encoding> header with a value of
  143. C<chunked> was sent in the request.  Note, writing zero-length data is
  144. a no-op.  Use the write_chunk_eof() method to signal end of entity
  145. body data.
  146.  
  147. Returns true if successful.
  148.  
  149. =item $s->format_chunk($data)
  150.  
  151. Returns the string to be written for the given chunk of data.
  152.  
  153. =item $s->write_chunk_eof(%trailers)
  154.  
  155. Will write eof marker for chunked data and optional trailers.  Note
  156. that trailers should not really be used unless is was signaled
  157. with a C<Trailer> header.
  158.  
  159. Returns true if successful.
  160.  
  161. =item $s->format_chunk_eof(%trailers)
  162.  
  163. Returns the string to be written for signaling EOF.
  164.  
  165. =item ($code, $mess, %headers) = $s->read_response_headers( %opts )
  166.  
  167. Read response headers from server.  The $code is the 3 digit HTTP
  168. status code (see L<HTTP::Status>) and $mess is the textual message
  169. that came with it.  Headers are then returned as key/value pairs.
  170. Since key letter casing is not normalized and the same key can occur
  171. multiple times, assigning these values directly to a hash might be
  172. risky.
  173.  
  174. As a side effect this method updates the 'peer_http_version'
  175. attribute.
  176.  
  177. The method will raise exceptions (die) if the server does not speak
  178. proper HTTP.
  179.  
  180. Options might be passed in as key/value pairs.  There are currently
  181. only two options supported; C<laxed> and C<junk_out>.
  182.  
  183. The C<laxed> option will make C<read_response_headers> more forgiving
  184. towards servers that have not learned how to speak HTTP properly.  The
  185. <laxed> option is a boolean flag, and is enabled by passing in a TRUE
  186. value.  The C<junk_out> option can be used to capture bad header lines
  187. when C<laxed> is enabled.  The value should be an array reference.
  188. Bad header lines will be pushed onto the array.
  189.  
  190. =item $n = $s->read_entity_body($buf, $size);
  191.  
  192. Reads chunks of the entity body content.  Basically the same interface
  193. as for read() and sysread(), but buffer offset is not supported yet.
  194. This method should only be called after a successful
  195. read_response_headers() call.
  196.  
  197. The return value will be C<undef> on errors, 0 on EOF, -1 if no data
  198. could be returned this time, and otherwise the number of bytes added
  199. to $buf.
  200.  
  201. This method might raise exceptions (die) if the server does not speak
  202. proper HTTP.
  203.  
  204. =item %headers = $s->get_trailers
  205.  
  206. After read_entity_body() has returned 0 to indicate end of the entity
  207. body, you might call this method to pick up any trailers.
  208.  
  209. =item $s->_rbuf
  210.  
  211. Get/set the read buffer content.  The read_response_headers() and
  212. read_entity_body() methods use an internal buffer which they will look
  213. for data before they actually sysread more from the socket itself.  If
  214. they read too much, the remaining data will be left in this buffer.
  215.  
  216. =item $s->_rbuf_length
  217.  
  218. Returns the number of bytes in the read buffer.
  219.  
  220. =back
  221.  
  222. =head1 SUBCLASSING
  223.  
  224. The read_response_headers() and read_entity_body() will invoke the
  225. sysread() method when they need more data.  Subclasses might want to
  226. override this method to contol how reading takes place.
  227.  
  228. The object itself is a glob.  Subclasses should avoid using hash key
  229. names prefixed with C<http_> and C<io_>.
  230.  
  231. =head1 SEE ALSO
  232.  
  233. L<LWP>, L<IO::Socket::INET>, L<Net::HTTP::NB>
  234.  
  235. =head1 COPYRIGHT
  236.  
  237. Copyright 2001 Gisle Aas.
  238.  
  239. This library is free software; you can redistribute it and/or
  240. modify it under the same terms as Perl itself.
  241.  
  242. =cut
  243.